home *** CD-ROM | disk | FTP | other *** search
/ APDL Eductation Resources / APDL Eductation Resources.iso / programs / database / vicinity / !Vicinity / !Help < prev    next >
Encoding:
Text File  |  1995-07-26  |  16.1 KB  |  326 lines

  1. © Dizzy Wizard Software, 1995      << See New features >>
  2. Vicinity by John 'Juggler' Wright version 1.22
  3.  
  4. **** PLEASE NOTE: Existing compressed bases will NOT work with this version ****
  5.  
  6.                 Vicinity Help File (This file available as Impression file)
  7.                 ------------------
  8. >> What does Vicinity do?
  9.   Vicinity is just another address book hiden under a flashy name. It has
  10. all the usual features: it holds name, address and telephone information;
  11. you can flick through the records; search for a name (case insensitive);
  12. goto to a record; insert a record; delete a record; create new bases; import
  13. other address book formats. (Really!)
  14.  
  15. >> Loading
  16.   Double-click (using SELECT) on the !Vicinity icon in the filer window.
  17. Once loaded Vicinity's main window will open in the centre of the screen
  18. and Vicinity's filer icon will appear on the icon bar. The main window will
  19. not open if there isn't a file inside !Vicinity.Auto called Default which is
  20. (obviously) loaded automatically. This Default file can also be loaded from
  21. the icon bar menu by clicking on 'Load Default'. To save a base as the
  22. default click MENU in the address book window and select Make this Default.
  23. Vicinity will save the file as <Vicinity$Dir>.Auto.Default.
  24.  
  25. >> To create a base
  26.   This can be done by clicking MENU on Vicinity's icon on the icon bar then
  27. choosing Create from the menu or doing the same with the menu from the main
  28. window or clicking ADJUST on the Delete icon in the main window.
  29.   'Do you want to create a new vicinity file? This will wipe all existing
  30. records' - If you want to save a base already loaded then click on the
  31. Cancel button then save your base, otherwise click on the Ok button to
  32. create a base with one record in it and the main window will open (or be
  33. updated) with Name, Address and Telephone in corresponding icons.
  34.  
  35. >> Loading an existing base
  36.   If Vicinity is loaded either drag the file from the filer window onto any
  37. part of vicinity (i.e. the icon bar icon, the main window) or double-click
  38. on the file in the filer window. If Vicinity is not loaded but has been
  39. booted by the filer (*Filer_Boot or been 'seen' be the filer when the filer
  40. window was opened) you can double-click on the Vicinity file in a filer
  41. window and Vicinity will automatically load itself and the that base.
  42.  
  43. >> Saving a base: As a Vicinity file (Key short-cut F3)
  44.   With the main window up, click SELECT on the 'Save' button - this will
  45. save the base where it was last saved or open a save box for you to specify
  46. the saving place.
  47.  
  48. >> Saving a base: As a Vicinity file and specify the saving place (F3)
  49.   With the main window up, click ADJUST on the 'Save' button - this will
  50. open a save box for you to speciy the saving place by draging the Vicinity
  51. file icon to a filer window or by typing in the path name.
  52.  
  53. >> Saving a base: As a CSV file for use with Mail Merge (With Impression)
  54.   With the main window up, click MENU on the 'Save' button - this will open
  55. a large save box allowing you to save as a Text File or CSV File (Comma
  56. Seperated Variables) and allowing you to specify the way the files are
  57. saved. In the CSV File section the option 'Field names' means the first line
  58. in the CSV File is 'name,address,telephone' which Mail Merge takes as the
  59. names each of the parts of the record. To save the CSV File hold SELECT on
  60. the CSV File icon and drag the mouse pointer to a filer window and drop
  61. SELECT. You can also change the saved name by typing in the icon below the
  62. dragable one.
  63.  
  64. >> Saving a base: As a Text File (For above as well, key short-cut SHIFT+F3)
  65.   With the main window up, click MENU on the 'Save' button - this will open
  66. a large save box allowing you to save as a Text File or CSV File (Comma
  67. Seperated Variables) and allowing you to specify the way the files are
  68. saved. Option DDF format saves the file with Impression styles so that if
  69. the Text File is dragged into an Impression frame the name is in bold, the
  70. address is normal, and the telephone number has 'Tel:' in normal and the
  71. numbers in italics. To save the Text File hold SELECT on the Text File icon
  72. and drag the mouse pointer to a filer window and drop SELECT. You can also
  73. change the saved name by typing in the icon below the dragable one.
  74.  
  75. >> Creating a new record into a base (Key short-cut INSERT)
  76.   With the main window up, click SELECT on the Insert button.
  77. 'Are you sure you want to insert a record?' - Click Ok to create a new
  78. record at the end of the base (the main window will be updated to display
  79. the new record). Name, Address and Telephone texts will be in the
  80. corresponding icons.
  81.  
  82. >> Removing an existing record from a base
  83.   With the main window up, click SELECT on the Delete button.
  84. 'Are you sure you want to delete '<record name>'?' - Click Ok to remove the
  85. named record at the viewed position in the base.
  86.  
  87. >> Searching for a record (Key short-cut F4, Previous search string F2)
  88.   With the main window up, click SELECT on the Search button. The Search
  89. window will be opened near the mouse pointer. The option 'Names only' means
  90. the search will only look at the names field (first), the option Forward
  91. means the search will start with the next record instead of from the first.
  92. Click on the Search button in the Search window to search for the text.
  93. Please note the search is not case sensitive and will search for the text
  94. string in a text string (BASIC INSTR command).
  95.  
  96. >> Jumping directly to a record (Goto) (Key short-cut F5)
  97.   With the main window up, click ADJUST on the Search button. The Goto
  98. window will be opened near the mouse pointer. Type the record number and
  99. press RETURN or click on the Goto button and the main window will display
  100. that record (if it exists). Please note typing a record greater than the
  101. number in the base will get you the first record and a number below one will
  102. get you the last record.
  103.  
  104. >> Listing all entries names.
  105.   With the main window up, click MENU on the Search button. A menu will be
  106. opened showing the names of all the entries in the address book. Clicking on
  107. any of these will make Vicinity go directly to that record.
  108.  
  109. >> Key short-cuts (The same as !Edit most of the time)
  110. Key(s) name             Operation/Window
  111. ESC                     Closes the main window (Not the file)
  112. F3                      Vicinity file save window
  113. F4                      Search window
  114. F5                      Goto window
  115. SHIFT + F3              CSV and Text File save window
  116. PAGE UP                 Record + 1
  117. PAGE DOWN               Record - 1
  118. CTRL + UP               First record
  119. CTRL + DOWN             Last record
  120. INSERT                  Create a new record
  121.  
  122. >> Vicinity can import other peoples address book formats...
  123.   Just drag a foreign address book's file onto Vicinity and you will be able
  124. to load it as a normal Vicinity file.
  125.  
  126.   Current formats that are understood:
  127.         Author                  Application     Magazine
  128.        ¹Kevin Swinton           Direct          Archimedes World
  129.        ¹Mark Hobson             TelAddr         Archimedes World
  130.        ²J. Robbins              Card2           Archimedes World
  131.        ¹Barry Wickett           BigBook         Archimedes World
  132.        ²Toby Smith              MailLabel       Eureka (The Arm Club)
  133.        ¹Chris Davis             NewsFlash       Bulletin Board(s)
  134.        ¹Neil Walker             Addresses       <none>
  135.  
  136.  Current formats that can be saved from Vicinity:
  137.          Application/Filetype
  138.         ²Text
  139.         ²DDF Text
  140.         ²Tag Text
  141.         ¹CSV
  142.         ¹Direct
  143.         ²Card2
  144.  
  145.  Coming soon! Pocket Book/Psion file conversion. If I get the file format!
  146.  
  147.         ¹ as a whole database with multiple records.
  148.         ² as a single record which can be added to an existing base.
  149.  
  150. >>> 1.22 - Slight changes. Dialing closes windows, Dial on search, more help supported.
  151.            NEW Compression module which is incompatible with older versions!
  152.  
  153. >>> 1.21 - Made ready for many more file formats to be saved FROM Vicinity.
  154.            Ability to save as Direct and Card2 file formats.
  155.  
  156. >>> 1.20 - New menu structure! And a clipboard.
  157.  
  158. >>> What are the NEW features to version 1.19!
  159.  
  160. >> Additional buttons!?
  161.   The one with the telephone (which is only displayed when the Serial Block
  162. Driver application has been booted) is the same as the menu option 'Dial via
  163. modem'. The one with the red line on a white rectangle (a caret) is the same
  164. as the menu option 'Send to caret'.
  165.  
  166. >> Listing all entries names.
  167.   With the main window up, click MENU on the Search button. A menu will be
  168. opened showing the names of all the entries in the address book. Clicking on
  169. any of these will make Vicinity go directly to that record.
  170.  
  171. >>> 1.18 - Joined Dizzy Wizard Software, Redraw a little quicker
  172.  
  173. >>> What are the NEW features to version 1.17!
  174.  
  175. >> Basic Compression
  176.   The !RunImage has been changed so that BasCompress can be used on it.
  177. Since I copied the !RunImage from somewhere else when I originally wrote the
  178. program, there are many dormant procedures and functions. So many that a 38%
  179. BASIC file can be produced by running it through BasCompress (1.60)!
  180.  
  181. >> What are Extended Tasks?
  182.   These are programs stored in !Vicinity.Auto.Extended which use the data
  183. stored in an address book and either change it or convert it to something,
  184. they can do anything that might help anybody.
  185.  
  186. >> How do I use Extended Tasks?
  187.   They can be accessed from the address window's menu - at the bottom. Move
  188. the mouse pointer to the right and a list of the available Extended Tasks
  189. will be displayed. Choose any one and it will be run (from disc).
  190.  
  191. >> How can I write my own Extended Tasks?
  192.   Simple! Copy mine! I've use some functions (in BASIC) to get any passed
  193. parameters easily. Each Extended Task is run with the following parameters.
  194. Using DumpToPRN as an example:
  195.  
  196.         DumpToPRN <records> <address of Data> "<Info string>"
  197.  
  198.   The first REM statement at the very beginning of the file will be used in
  199. the menu as a short description of the operation done by the Extended Task.
  200. For your information this text starts at position six in the BASIC file so
  201. you can still fit a branch around it in a Utility or Absolute file type. It
  202. is feasible that a Text file could be put and run as an Extended Task.
  203.  
  204. >>> 1.16 - Although 1.15 crashed again!
  205.  ...due to weird things happening with the Templates file (and which /seems/
  206. to have been fixed by telling the Templates that sprites were sprites!).
  207. More file conversions and holding down on up or down arrows will move to the
  208. very beginning or the very end. Search control window added. Configure
  209. window changed so you can change the maximum records and whether compression
  210. is used for saving files.
  211.  
  212. >>> 1.15 - 1.14 crashed for some reason
  213.   So this version was built from 1.13 and the parts of 1.14 that worked. A
  214. Previous button added to Search window so that you know you can do it. Also,
  215. toggling of those radio/option buttons by using F3 and F4 (for keyboard
  216. people like myself). More file importing formats added.
  217.  
  218. >>> 1.14 - Replaced all occurances of 127 and 128 with variables.
  219.   The value of this variable is read in from the last entry of the Choices
  220. file and sets the maximum number of records that Vicinity can handle. I
  221. haven't, and don't even won't to think about, testing it if this number is
  222. less than the number of records in a file then loading this file.
  223.  
  224. >>> 1.13 - Able to import Termite Directory files
  225.            (!Termite.Protocols.Directory.Directory)
  226.  
  227. >>> 1.12 - Using MessageTrans
  228.            since DataSystem not registered and is too radical
  229.  
  230. >>> 1.11 - New file format since the other was decided upon a bit quickly
  231.            Still supports older formats but saves as the new format
  232.  
  233. >>> 1.10 - You can toggle the texture mapping in the configurations
  234.  
  235. >>> 1.09 - Interactive help supported fully
  236.  
  237. >>> What are the NEW features to version 1.08!
  238.  
  239.   Little oddity sorted out with type window - the Type again button didn't
  240. do anything! Inaddition, you can now put a prefix infront of numbers
  241. before dialling. This is configured in the configure window and is specified
  242. after clicking on the Dial via modem item in the menu. This also means that
  243. when the dial window comes up it shouldn't dial immediately as you won't
  244. have time to set the prefix button to on (since off is default). This means
  245. that it doesn't dial as soon as you've clicked on the Dial via modem item
  246. but after you click on the button Start dial in the dial window.
  247.   You can now load and save the default base by using the menus instead of
  248. just going through the directory structure of !Vicinity. To load the default
  249. the item is on the main menu from the Iconbar. To save the default, ie to
  250. make a different file the default, click on the Make this default button on
  251. the Base menu from the address window.
  252.  
  253. >>> What are the NEW features to version 1.07!
  254.  
  255. >> How to TYPE an entire record to the CARET!
  256.   Firstly, choose the record you want to type to the caret. Now put the
  257. caret where you want to type the record. Eg In an Edit window, or Termite
  258. window. Now click MENU in the main window. Choose Send to caret and a window
  259. will appear giving details about the typing. Vicinity will immediately start
  260. typing the current record to wherever the caret happens to be.
  261.  
  262. >>> 1.06 - Better use of Serial Block Drivers
  263.  
  264. >>> 1.05 - Updated Relocatable Modules
  265.  
  266. >>> What are the NEW features to version 1.04!
  267.  
  268. >> Files are now compressed when saved!
  269.   On some files I managed to get the compressed file to be around 13% the
  270. size of the original(!) and others to around 20%! I knew my file format
  271. wasted a lot of memory but to compress to 13%!
  272.   Vicinity will still load the non-compressed files and actually stores the
  273. base as the non-compressed files in memory.
  274.  
  275. >>> What are the NEW features to version 1.03!
  276.  
  277. >> How to DIAL the number in the current record!
  278.   Even more importantly you must have a telephone connected to the same line
  279. as the modem (which you also must have) if you want to make a voice call.
  280. This doesn't matter if you're phoning a computer which will beep at the
  281. modem, etc. You will also need to have the Block drivers found in an
  282. application called !SerialDev. These can be downloaded with RSDFS, Termite
  283. and the Internet Starter Kit. (I know this since I have them all!) You will
  284. probably be able to download them on their own.
  285.   Firstly you have to set up the configurations window. To do this click
  286. ADJUST on Vicinity's icon on the iconbar. The window will open in the centre
  287. and tell you the current settings. If you've used a comms program that uses
  288. Block drivers found in an application called !SerialDev then the first two
  289. should be easy. On a normal computer (Acorn) you should set these to
  290. Internal and port 0. The next two icons are for dialling and reseting the
  291. modem. For my US Robotics 14.4k modem the dialling string is ATDT with a
  292. space at the end (may not need this Termite does it though!) and the reset
  293. string is ATZ. This modem is Hayes compatible (I believe!) so these should
  294. work with any Hayes compatible modem.
  295.   If this was the first time you set up the configurations click SELECT on
  296. the Save button to save these settings. The Ok button will use the settings
  297. and not save them, the Cancel button will use the settings there when you
  298. opened the window without saving them.
  299.  
  300. >> The actual dialling business
  301.   Open the main window by clicking SELECT on the bar icon. Go to the record
  302. you want to dial the telephone number of. Click MENU in the main window.
  303. Choose the Dial item on the menu. Vicinity will dial the number and open a
  304. window allowing you to reset the modem or to dial the number again. Once it
  305. is ringing however, and you want a voice call, you ought to lift your
  306. telephones handset (If you have a handset), then click on Reset modem
  307. otherwise the modem will beep at everybody on the line!
  308.  
  309. >> Glossary
  310. Base    - One Vicinity file containing one or more records
  311. Field   - E.g. Name, Address or Telephone
  312. Record  - The main window displays one record
  313. SaveBox - Used to save a file to floppy disc, hard disc etc
  314. Modem   - You used it to get this probably
  315.           Otherwise, it's a Modulator/Demodulator
  316. RSDFS   - Remote Serial Disc Filing System by Chris Claydon of ARMed Forces
  317. Termite - Communications Environment by DoggySoft
  318.  
  319. >> Problems, queries, errors, bugs...
  320.  
  321.   EMail:        juggler@aschamhs.demon.co.uk
  322.    Fido:        2:255/93.7 as John Wright
  323.     BBS:        Arcade... John Wright
  324.                 Other.... Juggler
  325.   Other includes Databank, Digitax, Arctic, Renegade, Archiboard, and more
  326.